home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 23 / CU Amiga - Super CD-ROM 23 (June 1998).iso / CreatingGames / GameCreators / GRAAL2 / Graal2a.readme < prev    next >
Encoding:
Text File  |  1997-07-20  |  19.1 KB  |  548 lines
  1. Short:    GRAAL Graphic Adventure Authoring Language 2.1
  2. Author:   pethu@hotmail.com
  3. Uploader: pethu@hotmail.com
  4. Type:     game/role
  5. Replaces: Graal2a.lha
  6. Action:   PAL
  7.  
  8.  
  9.  
  10.  
  11.                               ============
  12.                                GRAAL  2.1
  13.                               ============
  14.  
  15.  
  16.                           Contents:
  17.  
  18.                           INTRODUCTION
  19.                           DISTRIBUTION
  20.                           COPYRIGHT NOTICE
  21.                           GRAAL REGISTRATION
  22.                           QUICK-START FOR OLD USERS
  23.                           RELEASE NOTES
  24.                           NEW FEATURES
  25.                           BUG FIXES
  26.                           FUTURE ENHANCEMENTS
  27.  
  28.  
  29.  
  30.                               INTRODUCTION
  31.                               ============
  32.  
  33. GRAAL is a script-based Graphic Adventure Authoring Language, delivered to
  34. your electronic doorstep complete with an editor and other development
  35. tools, a demo adventure, and more documentation than you can shake a
  36. pair of strong eye-glasses at.
  37.  
  38.  
  39.  
  40.                               DISTRIBUTION
  41.                               ============
  42.  
  43. GRAAL 2.1 is delivered on 4 disks plus the essential disk-mag-thingy
  44. "GRAAL Herald 2", which contains a new mini-demo and other stuff to
  45. help you out with the new features.
  46.  
  47. The GRAAL aminet archives should be unpacked to a common drawer on
  48. HD or in RAM, or to floppies named as follows:
  49.  
  50.   Graal2a.lha --> "GRAAL 2.1 - Disk A"
  51.   Graal2b.lha --> "GRAAL 2.1 - Disk B"
  52.   Graal2c.lha --> "GRAAL 2.1 - Disk C"
  53.   Graal2d.lha --> "GRAAL 2.1 - Disk D"
  54.  
  55. Anyone equipped with the C= installer program can then use the "HD_Install"
  56. icon found on Disk A to install the system to hard disk, or to update an
  57. existing development directory.
  58.  
  59.   GraalHerald2.lha
  60.  
  61. Just unpack this directory to an empty hard disk drawer of your choice.
  62.  
  63. (You may wish to copy GRAAL_Editor and GRAAL.guide there too, if you wish
  64. to study the scripts that make up the mini-demo in detail.)
  65.  
  66.  
  67.  
  68.                             COPYRIGHT NOTICE
  69.                             ================
  70.  
  71. GRAAL 2.1 is shareware. Copyright (c) 1997 Per Thulin.
  72.  
  73. This package may be freely distributed, as long as nothing except
  74. distribution costs are charged. All files must be kept together, either
  75. in the original, unaltered archives, or as a full hard disk installation
  76. done with the installer.
  77.  
  78. The GRAAL_2 driver program may be distributed on its own and for free
  79. as part of your own adventure, even commercially. There is no license
  80. fee - however, you should register (see below).
  81.  
  82. The registered user's personal key file, graal.key, must no longer be copied
  83. or re-distributed in any way. (This is a change from earlier versions, 
  84. which required the keyfile to be delivered as part of an encrypted game.
  85. This is no longer necessary.)
  86.  
  87. You are specifically forbidden to use any of the example material -
  88. characters, story, graphics or sound - in your own adventures.
  89.  
  90. I take no responsibility for any loss or damage that may result from the
  91. use of this software.
  92.  
  93.  
  94.  
  95.  
  96.                            GRAAL REGISTRATION
  97.                            ==================
  98.  
  99. The shareware version of GRAAL is not crippled in any way.
  100.  
  101. However, if you want to distribute your adventures, you will probably
  102. want the following:
  103.  
  104. * A way to copy the delivery files to a test directory for final tests.
  105.  
  106. * A way to compress the data to be able to put more on each floppy.
  107.  
  108. * A way to encrypt all scripts, graphics, and sound files to prevent
  109.   people from finding the solution to the game too easily.
  110.  
  111. If you register, you will receive a personal keyfile which enables you
  112. to use the GPRO program to do all of the above. It also enables you to
  113. switch off certain developer functions in the version of GRAAL you
  114. distribute to make it even safer - and harder to crack.
  115.  
  116. As an added bonus, your name appears in lights on the loading screen, 
  117. from which it cannot be removed - an extra copyright protection, you
  118. might say.
  119.  
  120. The keyfile will continue to work with any new versions uploaded
  121. to the Aminet. Updates are thus easily accessible and free of charge.
  122.  
  123. You are also put on a mailing list, and will receive an e-mail GRAAL
  124. newsletter from time to time (provided you are connected to the 'net).
  125.  
  126. Registering is as easy as sending 150 SEK (swedish crowns), or the
  127. equivalent of £ 15 (British pounds), in cash to me:
  128.  
  129.  
  130.                             Per Thulin
  131.                             Malmtorgsgatan 18
  132.                             S-653 40  KARLSTAD
  133.                             SWEDEN
  134.  
  135.      ---------------------------------------------------------------
  136.  
  137.      So, print out the file "registration.form" NOW and get mailin'!
  138.  
  139.      ---------------------------------------------------------------
  140.  
  141.  
  142.  
  143.                         QUICK-START FOR OLD USERS
  144.                         =========================
  145.  
  146. Just want to update and go on typing on your own adventure? OK. As usual, 
  147. I've kept the script changes needed to a minimum:
  148.  
  149. 1) Copy the new GRAAL_2, GRAAL_Editor, GRAAL.guide, GPRO, and GDC to
  150.    your development directory.
  151.  
  152.    If you have Commodore's installer program, use the HD_Install
  153.    script supplied on disk A to do this!
  154.  
  155.    Delete any old, renamed GRAAL driver programs floating around...
  156.  
  157.    (You may also wish to install the new GRAAL Manual.)
  158.  
  159.  
  160. 2) If you have used looped samples, read about the new handling of samples
  161.    and decide whether you have to put those samples into tracker modules.
  162.  
  163.    Whatever you decide to do, the very least you must do is change
  164.    the first parameter of all old SAM commands to either DEF or a
  165.    channel number instead of the old ONCE or LOOP parameter. Otherwise, 
  166.    the samples will not play.
  167.  
  168.  
  169. 3) Continue with your work. (That wasn't too bad, was it? :)
  170.  
  171.  
  172. 4) Read the rest of this file when you feel up to it!
  173.  
  174.  
  175.  
  176.                               RELEASE NOTES
  177.                               =============
  178.  
  179.  
  180. GRAAL 2.1 has been tested on
  181.  
  182. * A1200 68030/50/50Mhz (AGA) with 16+2MB RAM, running WB 3.0
  183.  
  184. * A600 68000 7MHz (ECS) with 2+2MB RAM, running WB 2.05 (sloow.. :)
  185.  
  186. * UAE/Win Amiga Emulator 0.6.8 (OCS), running WB 2.05 under
  187.   Windows 95 with DirectX on a 133MHz Pentium. Apart from
  188.   the pitiful sound emulation, everything runs OK including
  189.   the Editor.
  190.  
  191.  
  192.  
  193.                                NEW FEATURES
  194.                                ============
  195.  
  196.  
  197. Read the details in graal.guide. Most of these innovations are also
  198. featured in the GRAAL Herald 2 mini-demo.
  199.  
  200.  
  201. MULTIPLE CHARACTERS
  202.  
  203. * The player can have control over up to 4 characters - only one at a time, 
  204.   though.
  205.  
  206. * One alternate character at a time can follow the character under player
  207.   control around automatically.
  208.  
  209. * Even in single-character games, you can use the CHAR: statement to define
  210.   the main character as a global object, thus making it cursor-recognisable.
  211.  
  212.  
  213. MULTIPLE INVENTORIES
  214.  
  215. * Multiple inventories to go with the multiple characters - or to be used
  216.   as a feature on its own.
  217.  
  218. * The OBJECT: statement and REMOVE command have also been updated to enable
  219.   placing items in a specific inventory.
  220.  
  221.  
  222. USER AND STRING VARIABLES
  223.  
  224. * 12 global string variables.
  225.  
  226. * Print contents in TEXT, SAY, and other commands using the string #VARn#.
  227.  
  228. * Test the contents with IFVAR.
  229.  
  230. * Use the PROMPT command to let the user provide the string input.
  231.   (This uses the dialogue area to display the prompt and input string
  232.   being typed.)
  233.  
  234. * Set the string contents in the script with the SETVAR command.
  235.  
  236.  
  237. NEW NTSC TIMING FEATURE
  238.  
  239. * A new NTSC_TIMING: statement makes most pauses during the game equally
  240.   long regardless of whether the game is played on an NTSC or PAL system.
  241.  
  242.  
  243. IMPROVED SOUNDTRACKER MODULE SUPPORT
  244.  
  245. * Specify the BPM tempo for soundtracker modules.
  246.  
  247. * Allocate channels for soundtracker versus sound effects.
  248.  
  249. * Music now fades out over about 0.5 seconds instead of stopping
  250.   abruptly after TRACK OFF / TRACK NO.
  251.  
  252.  
  253. IMPROVED SOUND EFFECT SUPPORT
  254.  
  255. * Sound effects played alongside soundtracker music now works OK.
  256.  
  257. * Load frequently used sound effects in the graal.main script and replay
  258.   them with the new SOUND command.
  259.  
  260. Note: As a side effect of having switched sound routines, you can no longer
  261. loop samples with the old SAM LOOP parameter. If you need to loop samples, 
  262. put them into a soundtracker module and do it that way.
  263.  
  264.  
  265. IMPROVED CHARACTER DISPLAY CONTROL
  266.  
  267. * Alter the part of the character that will "aim" for the spot clicked
  268.   by the player.
  269.  
  270. * Adjust the space between the character's head and the SAY and THINK
  271.   text displays.
  272.  
  273.  
  274. IMPROVED DIALOGUE SENTENCE DISPLAY
  275.  
  276. * Long sentences can be displayed in the dialogue control area - each
  277.   "\" will act as a line break in the dialogue area as well as in the
  278.   scene area.
  279.  
  280. NOTE: In the previous versions, the "\" characters were ignored in the
  281. dialogue area - which means GRAAL may now display the alternatives in your
  282. old games a little differently than before. Check through all your LINE:
  283. statements!
  284.  
  285.  
  286. EDITOR UNDO COMMAND
  287.  
  288. The editor now has an "undo" option. Now, you can retrieve all those lines
  289. that you have removed with the "delete line" command by mistake...
  290.  
  291.  
  292. TRACE
  293.  
  294. * TRACE ON opens a window which will display each GRAAL condition or command
  295.   and prompt you to press a key before it is executed.
  296.  
  297. * TRACE OFF ends the single-step trace and returns GRAAL to normal.
  298.  
  299. * You can also switch the trace function on and off from within the
  300.   monitor. For more information, see the description of the TRACE
  301.   button in the monitor description below.
  302.  
  303.  
  304. DIVERSE
  305.  
  306. * "IFCHAR character" and "IFHERE object" conditions.
  307.  
  308.  
  309. CONTINUATION OF LINES = REPETITON OF INITIAL CONDITIONS
  310.  
  311. Call it what you like, the upshot of it all is that it often means less
  312. typing for you, and more readable scripts (It's a long way from structured
  313. programming, I agree, but it's convenient all the same :)
  314.  
  315. * You can repeat the initial conditions of an ACTION:, DACT: or LACT:
  316.   statement by simply starting the line with =; For example, if these
  317.   two lines are next to each other in a script
  318.  
  319.   ACTION: 3;IFOBJ 24;IFOBJ2 3;Say first line of actions for this combo...
  320.   ACTION: =;SAY second line of actions for this combo;EXIT
  321.  
  322.   the second line would really be interpreted as
  323.  
  324.   ACTION: 3;IFOBJ 24;IFOBJ2 3;SAY second line of actions for this combo;EXIT
  325.  
  326.   You see how this can save space in complex lines...
  327.  
  328. * If you have a sequence of initial conditions, but only want some of them
  329.   to be repeated, put a blank "no operation" command between them. Example:
  330.  
  331.   ACTION: 3;IFOBJ 24; ;IFOBJ2 3;Say first line of actions for this combo...
  332.   ACTION: =;SAY Second line of actions is for all rows matching IFOBJ 24;EXIT
  333.  
  334.   Here, the second line will be interpreted as
  335.  
  336.   ACTION: 3;IFOBJ 24;SAY Second line is for all actions matching IFOBJ 24;EXIT
  337.  
  338.   because the empty command broke the sequence of conditions to be repeated.
  339.  
  340. * The technique can also be used in DACT:s, although there is no initial
  341.   verb number in such statements.
  342.  
  343.   DACT: IFRF 1=0;SAY First line...
  344.   DACT: =;SAY Second line...;EXIT
  345.  
  346.  
  347. GENERAL VERB MATCHING
  348.  
  349. * In ACTION: statements, you can now replace the initial verb number with
  350.   a question mark to indicate that all normal player commands will be
  351.   matched by the statement. Example from a room script:
  352.  
  353.   ACTION: 3;SAY Yes, you may use command 3 in this room
  354.   ACTION: 3; ... some statements concerning stuff for verb 3 ...
  355.   ACTION: ?;SAY Sorry, no other commands are allowed!
  356.  
  357.   The last line will trap ANY player input except the "goto" command
  358.   (verb 0), which is considered a special case and must be handled
  359.   on its own.
  360.  
  361.  
  362. THE NEW ON-LINE MONITOR
  363.  
  364. At the first glance, the new monitor may look less impressive than its
  365. predecessor, which is totally wrong. It can display more information and
  366. also alter it in ways not possible before.
  367.  
  368. The new monitor can execute ANY graal command. That said, the ones you
  369. are most likely to use are:
  370.  
  371.   SETRF    to set room flags
  372.   SETOF    to set object flags
  373.   GOTO     to move between rooms
  374.   GET      to put things in the current inventory
  375.   REMOVE   to put things somewhere else
  376.  
  377. Learn all of these by heart, and you and the monitor will get along just
  378. fine!
  379.  
  380.  
  381. MANUAL CHANGES
  382.  
  383. * The tutorial manual has been expanded and somewhat re-arranged. For
  384.   example, a new chapter on multiple characters and inventories has been
  385.   added, as well as a description of the new monitor.
  386.  
  387. * The text files "Editor.text" and "Prod.text" has also been integrated
  388.   with the manual.
  389.  
  390.  
  391.  
  392.                                   BUG FIXES
  393.                                   =========
  394.  
  395.  
  396. (These are not all of the bug fixes, but some of those you are most likely
  397. to have become annoyed or puzzled by!)
  398.  
  399.  
  400. Documentation error:
  401. --------------------
  402.  
  403. The 2.0 tutorial erroneously stated that GRAAL 2 contains third-party
  404. compression software and requires the powerpacker.library. Neither of
  405. these statements are true - in the end, the best way to go about
  406. compressing and decompressing was to use built-in and "hand-made"
  407. functions. GRAAL is still a stand-alone program without any need for
  408. external libraries or other system files.
  409.  
  410.  
  411.  
  412. Inserting commands from parameter editor did not affect change counter.
  413. -----------------------------------------------------------------------
  414.  
  415. ...and if the change counter reads zero, the ordinary editor save function
  416. does not work. So, sometimes you may have thought you saved something
  417. and it turned out you didn't! Now fixed.
  418.  
  419.  
  420.  
  421. Better clean-up after crashes
  422. -----------------------------
  423.  
  424. On start-up, GRAAL now deletes any old .room, .section, .iff, .snd, .mod, 
  425. and graal.main files left in memory by a previous crash. This means changes
  426. you made in the scripts between runs will be guaranteed to take effect when
  427. restarting GRAAL.
  428.  
  429.  
  430.  
  431. STATIC: or ANIM: in starting room caused GRAAL to hang (a while later!)
  432. -----------------------------------------------------------------------
  433.  
  434. This is a very strange one, which has been with us since day one. However, 
  435. no-one but me has ever come in with a bug report about it!. Certain images, 
  436. in certain cases, on certain machines, when run from certain disk drives, 
  437. and with a certain memory usage on the machine, caused GRAAL to hang when
  438. used in STATIC: or ANIM: statements in the first room of the adventure.
  439. ( Phew! :)
  440.  
  441. The image hanging the system a while after executing the STATIC:
  442. statement worked fine if placed in the same spot by a BOBON command in
  443. a DACT: statement instead - which is more or less doing exactly the
  444. same thing in another way!
  445.  
  446. This is definitely an Amos Pro bug of some sort. I have now totally changed
  447. the structure of the code in the troubled area, and this seemed to cure
  448. the problem. However, I have no way of telling right now whether the
  449. problems have gone away forever. (My favourite theory right now is that
  450. the handling of an open hard disk file buffer somehow interfered with
  451. the access to the image bank. Makes no sense, I know, but that's why it has
  452. taken me this long to pin the problem down...)
  453.  
  454. Perhaps some general memory-thrashing problems have been sorted by this as
  455. well. I have a feeling I can do more GRAAL restarts and editing between
  456. re-boots now. However, that may just be a feeling...
  457.  
  458.  
  459.  
  460. CHAR OFF data for subsequent CHAR ON were not saved by MARK or SAVE
  461. -------------------------------------------------------------------
  462.  
  463. Now it is. I have not really considered the implications of this, and it
  464. is unlikely it should have bothered anyone in real life.
  465.  
  466.  
  467.  
  468.  
  469.                             FUTURE ENHANCEMENTS
  470.                             ===================
  471.  
  472. I've said it before, but this time I really think I WILL take it easy for
  473. a while - keep the bug reports and suggestions coming, though.
  474.  
  475. One major development that may be addressed in a future release is more
  476. advanced graphics in the command area. But don't hold your breath.
  477.  
  478. More automatic settings of MAX_-type parameters and cross-referencing
  479. from withing the editor or small utility proggies is also a possibility.
  480.  
  481. I also encourage other people to write such proggies. For example, make them
  482. produce reports over what is used where, which rooms connect to which, and
  483. so on. Because of the open-endedness of the GRAAL development environment, 
  484. this should be quite easy to do. Excellent AREXX exercises, I would think!
  485.  
  486.  
  487. *************************************************************************
  488. *                                                                       *
  489. *                                                                       *
  490. *                       T-T-THAT'S ALL, FOLKS!                          *
  491. *                                                                       *
  492. *                                                                       *
  493. *************************************************************************
  494.  
  495.  
  496. ============================= Archive contents =============================
  497.  
  498. Original  Packed Ratio    Date     Time    Name
  499. -------- ------- ----- --------- --------  -------------
  500.      447     216 51.6% 01-May-97 11:01:38  0.scene
  501.   124760   66825 46.4% 01-May-97 11:01:56  0.track
  502.     5377    2247 58.2% 01-May-97 11:01:06  1.section
  503.     1408     635 54.9% 01-May-97 11:01:02  18.room
  504.    22782   16265 28.6% 01-May-97 11:01:10  18BG.IFF
  505.     7410    3461 53.2% 01-May-97 11:01:12  18FG.IFF
  506.     1380     617 55.2% 01-May-97 11:01:04  19.room
  507.    15592    7180 53.9% 01-May-97 11:01:16  19BG.IFF
  508.    12508    3473 72.2% 01-May-97 11:01:18  19FG.IFF
  509.     3044     837 72.5% 01-May-97 11:01:40  29.scene
  510.     4499    1420 68.4% 01-May-97 11:18:26  Disk.info
  511.     3253    1343 58.7% 01-May-97 11:00:36  Diskinfo.graal
  512.      264      29 89.0% 01-May-97 10:59:44 +dpaint.font
  513.     3316    1919 42.1% 01-May-97 10:59:44 +8
  514.      264      29 89.0% 01-May-97 10:59:46 +emerald.font
  515.     6988    3647 47.8% 01-May-97 10:59:46 +20
  516.      264      29 89.0% 01-May-97 10:59:36 +garnet.font
  517.     3732    2426 34.9% 01-May-97 10:59:36 +9
  518.      784      49 93.7% 01-May-97 10:59:36 +hires-5a.font
  519.     1800    1079 40.0% 01-May-97 10:59:36 +6
  520.     1904    1164 38.8% 01-May-97 10:59:36 +7
  521.     2040    1222 40.0% 01-May-97 10:59:36 +8
  522.      524      41 92.1% 01-May-97 10:59:42 +olaf.font
  523.     4780    1691 64.6% 01-May-97 10:59:42 +24
  524.     5096    1897 62.7% 01-May-97 10:59:40 +27
  525.      264      29 89.0% 01-May-97 10:59:38 +times.font
  526.     3892    2110 45.7% 01-May-97 10:59:38 +14
  527.    22528    7946 64.7% 01-May-97 11:00:40  graal.main
  528.   359600  169052 52.9% 01-May-97 11:00:28  GRAAL_2
  529.     2817    1364 51.5% 01-May-97 11:18:26  GRAAL_2.info
  530.    11628    2262 80.5% 01-May-97 10:59:32  HD_Install
  531.     1939    1285 33.7% 01-May-97 11:18:22  HD_Install.info
  532.     2890     206 92.8% 01-May-97 11:01:24  NTITLE0.IFF
  533.     5020    1456 70.9% 01-May-97 11:01:28  NTITLE1.IFF
  534.     4328     867 79.9% 01-May-97 11:01:30  NTITLE2.IFF
  535.     6094    1787 70.6% 01-May-97 11:01:32  NTITLE3.IFF
  536.     3314     350 89.4% 01-May-97 11:01:34  NTITLE4.IFF
  537.     6276    1623 74.1% 01-May-97 11:01:36  NTITLE5.IFF
  538.     1386     265 80.8% 01-May-97 11:01:02  olaf_cursors.iff
  539.    15040    2095 86.0% 01-May-97 11:00:54  olaf_extras.iff
  540.    21782    5133 76.4% 01-May-97 11:00:52  olaf_original.iff
  541.    20882    5608 73.1% 01-May-97 11:01:00  olaf_symbols.iff
  542.     9672    2565 73.4% 01-May-97 11:00:44  olafcomm.iff
  543.     3364     560 83.3% 01-May-97 11:00:46  olafdlg.iff
  544.    17782   13116 26.2% 01-May-97 11:01:22  PS_Logo_ham6.iff
  545.    13340    6693 49.8% 01-May-97 11:00:48  wood.rsb
  546. -------- ------- ----- --------- --------
  547.   768054  346113 54.9% 05-May-97 00:03:22   46 files
  548.